<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: jetson-utils/imageWriter.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('imageWriter_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">imageWriter.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="imageWriter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifndef __IMAGE_WRITER_H_</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#define __IMAGE_WRITER_H_</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="videoOutput_8h.html">videoOutput.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classimageWriter.html">   50</a></span>&#160;<span class="keyword">class </span><a class="code" href="classimageWriter.html">imageWriter</a> : <span class="keyword">public</span> <a class="code" href="classvideoOutput.html">videoOutput</a></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;{</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        <span class="keyword">static</span> <a class="code" href="classimageWriter.html">imageWriter</a>* <a class="code" href="classimageWriter.html#a4729467d9c95d3e4d92cac3a98a6e96c">Create</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* path, <span class="keyword">const</span> <a class="code" href="structvideoOptions.html">videoOptions</a>&amp; options=<a class="code" href="structvideoOptions.html">videoOptions</a>() );</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        <span class="keyword">static</span> <a class="code" href="classimageWriter.html">imageWriter</a>* <a class="code" href="classimageWriter.html#a4729467d9c95d3e4d92cac3a98a6e96c">Create</a>( <span class="keyword">const</span> <a class="code" href="structvideoOptions.html">videoOptions</a>&amp; options );</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        <span class="keyword">virtual</span> <a class="code" href="classimageWriter.html#a0038555473cca96319845f4e67c92882">~imageWriter</a>();</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classimageWriter.html#a63ca941281c3fff61025a5d0c5bf824e">   72</a></span>&#160;        <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keywordtype">bool</span> <a class="code" href="classimageWriter.html#a63ca941281c3fff61025a5d0c5bf824e">Render</a>( T* image, uint32_t width, uint32_t height )           { <span class="keywordflow">return</span> <a class="code" href="classimageWriter.html#a63ca941281c3fff61025a5d0c5bf824e">Render</a>((<span class="keywordtype">void</span>**)image, width, height, imageFormatFromType&lt;T&gt;()); }</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        </div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classimageWriter.html#a63ca941281c3fff61025a5d0c5bf824e">Render</a>( <span class="keywordtype">void</span>* image, uint32_t width, uint32_t height, <a class="code" href="group__imageFormat.html#ga931c48e08f361637d093355d64583406">imageFormat</a> format );</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classimageWriter.html#ae5d8c048302526edb9e6a84edbc4cb97">   83</a></span>&#160;        <span class="keyword">virtual</span> <span class="keyword">inline</span> uint32_t <a class="code" href="classimageWriter.html#ae5d8c048302526edb9e6a84edbc4cb97">GetType</a>()<span class="keyword"> const         </span>{ <span class="keywordflow">return</span> <a class="code" href="classimageWriter.html#af767ee4c3dfbedd450b5e3c7f86b326a">Type</a>; }</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classimageWriter.html#af767ee4c3dfbedd450b5e3c7f86b326a">   88</a></span>&#160;        <span class="keyword">static</span> <span class="keyword">const</span> uint32_t <a class="code" href="classimageWriter.html#af767ee4c3dfbedd450b5e3c7f86b326a">Type</a> = (1 &lt;&lt; 5);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classimageWriter.html#a3d0b61d9546c58044cfa200b4126edda">  101</a></span>&#160;        <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classimageWriter.html#a3d0b61d9546c58044cfa200b4126edda">SupportedExtensions</a>[];</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classimageWriter.html#ae3f60a3765942132ffdfb27c72153359">IsSupportedExtension</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* ext );</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;        <a class="code" href="classimageWriter.html#ac6668cfccd5a5d9b93249cfc4f97fe96">imageWriter</a>( <span class="keyword">const</span> <a class="code" href="structvideoOptions.html">videoOptions</a>&amp; options );</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classimageWriter.html#a54cb8c71e88cd68fc9738486679fd304">  113</a></span>&#160;        uint32_t <a class="code" href="classimageWriter.html#a54cb8c71e88cd68fc9738486679fd304">mFileCount</a>;</div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classimageWriter.html#afc478c1ac925683ca2709668775bbc7d">  114</a></span>&#160;        <span class="keywordtype">char</span>     <a class="code" href="classimageWriter.html#afc478c1ac925683ca2709668775bbc7d">mFileOut</a>[1024];</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;};</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classimageWriter_html_a3d0b61d9546c58044cfa200b4126edda"><div class="ttname"><a href="classimageWriter.html#a3d0b61d9546c58044cfa200b4126edda">imageWriter::SupportedExtensions</a></div><div class="ttdeci">static const char * SupportedExtensions[]</div><div class="ttdoc">String array of supported image file extensions, terminated with a NULL sentinel value. </div><div class="ttdef"><b>Definition:</b> imageWriter.h:101</div></div>
<div class="ttc" id="videoOutput_8h_html"><div class="ttname"><a href="videoOutput_8h.html">videoOutput.h</a></div></div>
<div class="ttc" id="classvideoOutput_html"><div class="ttname"><a href="classvideoOutput.html">videoOutput</a></div><div class="ttdoc">The videoOutput API is for rendering and transmitting frames to video input devices such as display w...</div><div class="ttdef"><b>Definition:</b> videoOutput.h:86</div></div>
<div class="ttc" id="classimageWriter_html"><div class="ttname"><a href="classimageWriter.html">imageWriter</a></div><div class="ttdoc">Save an image or set of images to disk. </div><div class="ttdef"><b>Definition:</b> imageWriter.h:50</div></div>
<div class="ttc" id="structvideoOptions_html"><div class="ttname"><a href="structvideoOptions.html">videoOptions</a></div><div class="ttdoc">The videoOptions struct contains common settings that are used to configure and query videoSource and...</div><div class="ttdef"><b>Definition:</b> videoOptions.h:37</div></div>
<div class="ttc" id="classimageWriter_html_ae5d8c048302526edb9e6a84edbc4cb97"><div class="ttname"><a href="classimageWriter.html#ae5d8c048302526edb9e6a84edbc4cb97">imageWriter::GetType</a></div><div class="ttdeci">virtual uint32_t GetType() const</div><div class="ttdoc">Return the interface type (imageWriter::Type) </div><div class="ttdef"><b>Definition:</b> imageWriter.h:83</div></div>
<div class="ttc" id="classimageWriter_html_a54cb8c71e88cd68fc9738486679fd304"><div class="ttname"><a href="classimageWriter.html#a54cb8c71e88cd68fc9738486679fd304">imageWriter::mFileCount</a></div><div class="ttdeci">uint32_t mFileCount</div><div class="ttdef"><b>Definition:</b> imageWriter.h:113</div></div>
<div class="ttc" id="classimageWriter_html_afc478c1ac925683ca2709668775bbc7d"><div class="ttname"><a href="classimageWriter.html#afc478c1ac925683ca2709668775bbc7d">imageWriter::mFileOut</a></div><div class="ttdeci">char mFileOut[1024]</div><div class="ttdef"><b>Definition:</b> imageWriter.h:114</div></div>
<div class="ttc" id="classimageWriter_html_a0038555473cca96319845f4e67c92882"><div class="ttname"><a href="classimageWriter.html#a0038555473cca96319845f4e67c92882">imageWriter::~imageWriter</a></div><div class="ttdeci">virtual ~imageWriter()</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="classimageWriter_html_ae3f60a3765942132ffdfb27c72153359"><div class="ttname"><a href="classimageWriter.html#ae3f60a3765942132ffdfb27c72153359">imageWriter::IsSupportedExtension</a></div><div class="ttdeci">static bool IsSupportedExtension(const char *ext)</div><div class="ttdoc">Return true if the extension is in the list of SupportedExtensions. </div></div>
<div class="ttc" id="classimageWriter_html_ac6668cfccd5a5d9b93249cfc4f97fe96"><div class="ttname"><a href="classimageWriter.html#ac6668cfccd5a5d9b93249cfc4f97fe96">imageWriter::imageWriter</a></div><div class="ttdeci">imageWriter(const videoOptions &amp;options)</div></div>
<div class="ttc" id="classimageWriter_html_a4729467d9c95d3e4d92cac3a98a6e96c"><div class="ttname"><a href="classimageWriter.html#a4729467d9c95d3e4d92cac3a98a6e96c">imageWriter::Create</a></div><div class="ttdeci">static imageWriter * Create(const char *path, const videoOptions &amp;options=videoOptions())</div><div class="ttdoc">Create an imageWriter instance from a path and optional videoOptions. </div></div>
<div class="ttc" id="classimageWriter_html_af767ee4c3dfbedd450b5e3c7f86b326a"><div class="ttname"><a href="classimageWriter.html#af767ee4c3dfbedd450b5e3c7f86b326a">imageWriter::Type</a></div><div class="ttdeci">static const uint32_t Type</div><div class="ttdoc">Unique type identifier of imageWriter class. </div><div class="ttdef"><b>Definition:</b> imageWriter.h:88</div></div>
<div class="ttc" id="classimageWriter_html_a63ca941281c3fff61025a5d0c5bf824e"><div class="ttname"><a href="classimageWriter.html#a63ca941281c3fff61025a5d0c5bf824e">imageWriter::Render</a></div><div class="ttdeci">bool Render(T *image, uint32_t width, uint32_t height)</div><div class="ttdoc">Save the next frame. </div><div class="ttdef"><b>Definition:</b> imageWriter.h:72</div></div>
<div class="ttc" id="group__imageFormat_html_ga931c48e08f361637d093355d64583406"><div class="ttname"><a href="group__imageFormat.html#ga931c48e08f361637d093355d64583406">imageFormat</a></div><div class="ttdeci">imageFormat</div><div class="ttdoc">The imageFormat enum is used to identify the pixel format and colorspace of an image. </div><div class="ttdef"><b>Definition:</b> imageFormat.h:49</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_54a0acf6da04fe2ed9410b4c6369bc5d.html">jetson-utils</a></li><li class="navelem"><a class="el" href="imageWriter_8h.html">imageWriter.h</a></li>
    <li class="footer">Generated on Tue Jul 14 2020 21:59:34 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
